Create AdjustBalance for Panama market in Ericsson OSC System.
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/adjustBalance
URL Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y(PA) |
| name | type | description | required |
|---|
| client_id | string | Public identifier to the application o channel | Y |
| client_secret | string | Is a secret known only to the application and the authorization server | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Request Data model:
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|
| status | string | Status of the operation | N |
| reason | string | Text describing the reason for the action/task. | Y |
| adjustType | string | The type of the adjustment. For example: recurringChargeDebit,oneTimeChargeCredit,oneTimeChargeDebit,goodWillCredit,generalDebit. | Y |
| amount | object | Indicate the amount on the bucket. | Y |
| amount.amount | number | Numeric value in a given unit. | Y |
| amount.units | string | Unit. | Y |
| bucket | object | A reference to the bucket impacted by the request or the value itself. | N |
| bucket.id | string | Unique identifier. | N |
| logicalResource[] | array | A list of references to the logical resources that can be used to identify the bucket balance for example where product ids are not unique. | Y |
| logicalResource[].id | string | Unique identifier. Service Number or MSISDN | Y |
| characteristic[] | array | A list of characteristics. Used to provide information about any other entity with relation to the operation. | N |
| characteristic[].name | string | A name to identify the characteristic. | N |
| characteristic[].value | string | The value of the characteristic. | N |
| requestedDate | string | Date when the deduction request was received in the server. | N |
| @type | string | When sub-classing, this defines the sub-class Extensible name. | N |
Response Data model:
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|
| status | string | Status of the operation | N |
| reason | string | Text describing the reason for the action/task. | N |
| adjustType | string | The type of the adjustment. For example: recurringChargeDebit,oneTimeChargeCredit,oneTimeChargeDebit,goodWillCredit,generalDebit. | N |
| amount | object | Indicate the amount on the bucket. | Y |
| amount.amount | number | Numeric value in a given unit. | Y |
| amount.units | string | Unit. | Y |
| logicalResource.id | string | Unique identifier. Service Number or MSISDN | Y |
| logicalResource.@type | string | Type of logical resource
Possible Value for PA: MSISDN | Y |
| logicalResource.@baseType | string | When sub-classing, this defines the super-class | Y |
| @type | string | When sub-classing, this defines the sub-class Extensible name. | N |
Key Considerations :
PA Mynehub to Ericsson:
- adjustType is mandatory value and expected value are "debit" or "datacredit".
- if its repayment use case then adjustType : debit.
- if its advance Balance use case then adjustType : datacredit.
- amount.amount should be adjustment amount
- amount.units should be "USD"
- logicalResoruce.id is service number or MSISDN
- characteristic.name == "AdjustmentCode" value will be change based adjustType . And possible values are CP or CC.
- CP will applicable if adjustType is datacredit
- CC will applicable if adjustType is debit
- characteristic.name == "transactionId" value should be Myne hub transactionId.
- '@type' value should always "ADESALDO".
- "reason" value always "SK2.0".